/* 
    Licensed to the Apache Software Foundation (ASF) under one
    or more contributor license agreements.  See the NOTICE file
    distributed with this work for additional information
    regarding copyright ownership.  The ASF licenses this file
    to you under the Apache License, Version 2.0 (the
    "License"); you may not use this file except in compliance
    with the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing,
    software distributed under the License is distributed on an
    "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
    KIND, either express or implied.  See the License for the
    specific language governing permissions and limitations
    under the License.  
 */
package erwiki.plugins;

import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Map;
import java.util.regex.Pattern;

import org.apache.log4j.Logger;
import org.elwiki_data.WikiPage;
import org.jdom2.Element;
import org.jdom2.Namespace;
import org.jdom2.output.Format;
import org.jdom2.output.XMLOutputter;

import erwiki.api.core.WikiContext;
import erwiki.api.exceptions.PluginException;
import erwiki.api.exceptions.ProviderException;
import erwiki.api.plugin.WikiPlugin;

/**
 * Плагин ErWiki. Создает индекс страниц по заданному шаблону.</br>
 * По умолчанию включены все страницы.
 * <p>
 * Это переписанная версия более ранней версии JSPWiki IndexPlugin, с использованием JDOM2.
 * <p>
 * Параметры плагина (из AbstractReferralPlugin):
 * <ul>
 * <li><b>include</b> - Шаблон регулярного выражения для обозначения страниц, которые следует
 * включить.</li>
 * <li><b>exclude</b> - Шаблон регулярного выражения для обозначения страниц, которые следует
 * исключить.</li>
 * </ul>
 *
 * @author Ichiro Furusato
 */
public class IndexPlugin extends AbstractReferralPlugin implements WikiPlugin {

	private static final Logger log = Logger.getLogger(IndexPlugin.class);

	private Namespace xmlns_XHTML = Namespace.getNamespace("http://www.w3.org/1999/xhtml");

	/**
	 * {@inheritDoc}
	 */
	@Override
	public String execute(WikiContext context, Map<String, String> params) throws PluginException {
		super.initialize(context, params);

		String include = params.get(PARAM_INCLUDE);
		String exclude = params.get(PARAM_EXCLUDE);

		Element masterDiv = getElement("div", "index");
		Element indexDiv = getElement("div", "header");
		masterDiv.addContent(indexDiv);
		try {
			List<WikiPage> pages = listPages(context, include, exclude);
			Collections.sort(pages, WikiPage::compareTo);
			char initialChar = '\u0020'; // пробел.
			Element currentDiv = new Element("div", xmlns_XHTML);
			for (WikiPage page : pages) {
				if (page.isInternalPage()) {
					continue;
				}
				String name = page.getName();
				if (name.charAt(0) != initialChar) {
					if (initialChar != '\u0020') {
						indexDiv.addContent(" - ");
					}
					initialChar = name.charAt(0);
					masterDiv.addContent(makeHeader(String.valueOf(initialChar)));
					currentDiv = getElement("div", "body");
					masterDiv.addContent(currentDiv);
					indexDiv.addContent(getLink("#" + initialChar, String.valueOf(initialChar)));
				} else {
					currentDiv.addContent(", ");
				}
				currentDiv.addContent(getLink(context.getURL(WikiContext.PAGE_VIEW, page.getId()), name));
			}

		} catch (ProviderException e) {
			log.warn("could not load page index", e);
			throw new PluginException(e.getMessage());
		}
		// сериализовать в строку raw формата (без изменений в пробелах)
		XMLOutputter out = new XMLOutputter(Format.getRawFormat());
		return out.outputString(masterDiv);
	}

	private Element getLink(String href, String content) {
		Element a = new Element("a", xmlns_XHTML);
		a.setAttribute("href", href);
		a.addContent(content);
		return a;
	}

	private Element makeHeader(String initialChar) {
		Element span = getElement("span", "section");
		Element a = new Element("a", xmlns_XHTML);
		a.setAttribute("id", initialChar);
		a.addContent(initialChar);
		span.addContent(a);
		return span;
	}

	private Element getElement(String gi, String classValue) {
		Element elt = new Element(gi, xmlns_XHTML);
		elt.setAttribute("class", classValue);
		return elt;
	}

	/**
	 * Захватывает список всех страниц и фильтрует их в соответствии с шаблонами включения/исключения.
	 *
	 * @param context
	 * @param include
	 * @param exclude
	 * @return Список, содержащий названия страниц, которые соответствовали фильтрам.
	 * @throws ProviderException
	 */
	private List<WikiPage> listPages(WikiContext context, String include, String exclude) throws ProviderException {
		Pattern includePattern = include != null ? Pattern.compile(include) : Pattern.compile(".*");
		// в названиях страниц нет управляющих символов:
		Pattern excludePattern = exclude != null ? Pattern.compile(exclude) : Pattern.compile("\\p{Cntrl}");
		List<WikiPage> result = new ArrayList<>();
		Collection<WikiPage> pages = pageManager.getAllPages();
		for (WikiPage page : pages) {
			String pageName = page.getName();
			if (excludePattern.matcher(pageName).matches()) {
				continue;
			}
			if (includePattern.matcher(pageName).matches()) {
				result.add(page);
			}
		}
		return result;
	}

}
